Cancels an armed timer.

OSStatus MPCancelTimer (
    MPTimerID timerID, 
    AbsoluteTime *timeRemaining
);

Parameter descriptions

timerID

The ID of the armed timer you want to cancel.

timeRemaining

On return, the timeRemaining contains the time remaining before the timer would have expired.

function result

A result code. If the timer has already expired, this function returns kMPInsufficientResourcesErr.

DISCUSSION

Also see the function MPArmTimer.

VERSION NOTES

Introduced with Multiprocessing Services 2.0.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.

© 2000 Apple Computer, Inc. (Last Updated 7/13/2000)